<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensorbase.resource.users;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.StringReader;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.io.StringWriter;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.HashMap;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.HashSet;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.Map;<a name="line.8"></a>
<FONT color="green">009</FONT>    import java.util.Set;<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>    import javax.xml.bind.JAXBContext;<a name="line.11"></a>
<FONT color="green">012</FONT>    import javax.xml.bind.Marshaller;<a name="line.12"></a>
<FONT color="green">013</FONT>    import javax.xml.bind.Unmarshaller;<a name="line.13"></a>
<FONT color="green">014</FONT>    import javax.xml.parsers.DocumentBuilder;<a name="line.14"></a>
<FONT color="green">015</FONT>    import javax.xml.parsers.DocumentBuilderFactory;<a name="line.15"></a>
<FONT color="green">016</FONT>    import javax.xml.transform.Transformer;<a name="line.16"></a>
<FONT color="green">017</FONT>    import javax.xml.transform.TransformerFactory;<a name="line.17"></a>
<FONT color="green">018</FONT>    import javax.xml.transform.dom.DOMSource;<a name="line.18"></a>
<FONT color="green">019</FONT>    import javax.xml.transform.stream.StreamResult;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import org.hackystat.sensorbase.db.DbManager;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.hackystat.utilities.stacktrace.StackTrace;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.hackystat.utilities.tstamp.Tstamp;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.Properties;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.Property;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.User;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.UserIndex;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.UserRef;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.Users;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.hackystat.sensorbase.server.Server;<a name="line.30"></a>
<FONT color="green">031</FONT>    import static org.hackystat.sensorbase.server.ServerProperties.XML_DIR_KEY;<a name="line.31"></a>
<FONT color="green">032</FONT>    import static org.hackystat.sensorbase.server.ServerProperties.TEST_DOMAIN_KEY;<a name="line.32"></a>
<FONT color="green">033</FONT>    import static org.hackystat.sensorbase.server.ServerProperties.ADMIN_EMAIL_KEY;<a name="line.33"></a>
<FONT color="green">034</FONT>    import static org.hackystat.sensorbase.server.ServerProperties.ADMIN_PASSWORD_KEY;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.w3c.dom.Document;<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>    /**<a name="line.37"></a>
<FONT color="green">038</FONT>     * Manages access to the User resources. <a name="line.38"></a>
<FONT color="green">039</FONT>     * Loads default definitions if available. <a name="line.39"></a>
<FONT color="green">040</FONT>     * <a name="line.40"></a>
<FONT color="green">041</FONT>     * Thread Safety Note: This class must NOT invoke any methods from ProjectManager or <a name="line.41"></a>
<FONT color="green">042</FONT>     * SensorDataManager in order to avoid potential deadlock. (ProjectManager and SensorDataManager<a name="line.42"></a>
<FONT color="green">043</FONT>     * both invoke methods from UserManager, so if UserManager were to invoke a method from<a name="line.43"></a>
<FONT color="green">044</FONT>     * either of these two classes, then we would have multiple locks not being acquired in the<a name="line.44"></a>
<FONT color="green">045</FONT>     * same order, which produces the potential for deadlock.)<a name="line.45"></a>
<FONT color="green">046</FONT>     *   <a name="line.46"></a>
<FONT color="green">047</FONT>     * @author Philip Johnson<a name="line.47"></a>
<FONT color="green">048</FONT>     */<a name="line.48"></a>
<FONT color="green">049</FONT>    public class UserManager {<a name="line.49"></a>
<FONT color="green">050</FONT>      <a name="line.50"></a>
<FONT color="green">051</FONT>      /** Holds the class-wide JAXBContext, which is thread-safe. */<a name="line.51"></a>
<FONT color="green">052</FONT>      private JAXBContext jaxbContext;<a name="line.52"></a>
<FONT color="green">053</FONT>      <a name="line.53"></a>
<FONT color="green">054</FONT>      /** The Server associated with this SdtManager. */<a name="line.54"></a>
<FONT color="green">055</FONT>      Server server; <a name="line.55"></a>
<FONT color="green">056</FONT>      <a name="line.56"></a>
<FONT color="green">057</FONT>      /** The DbManager associated with this server. */<a name="line.57"></a>
<FONT color="green">058</FONT>      DbManager dbManager;<a name="line.58"></a>
<FONT color="green">059</FONT>      <a name="line.59"></a>
<FONT color="green">060</FONT>      /** The UserIndex open tag. */<a name="line.60"></a>
<FONT color="green">061</FONT>      public static final String userIndexOpenTag = "&lt;UserIndex&gt;";<a name="line.61"></a>
<FONT color="green">062</FONT>      <a name="line.62"></a>
<FONT color="green">063</FONT>      /** The UserIndex close tag. */<a name="line.63"></a>
<FONT color="green">064</FONT>      public static final String userIndexCloseTag = "&lt;/UserIndex&gt;";<a name="line.64"></a>
<FONT color="green">065</FONT>      <a name="line.65"></a>
<FONT color="green">066</FONT>      /** The initial size for Collection instances that hold the Users. */<a name="line.66"></a>
<FONT color="green">067</FONT>      private static final int userSetSize = 127;<a name="line.67"></a>
<FONT color="green">068</FONT>      <a name="line.68"></a>
<FONT color="green">069</FONT>      /** The in-memory repository of Users, keyed by Email. */<a name="line.69"></a>
<FONT color="green">070</FONT>      private Map&lt;String, User&gt; email2user = new HashMap&lt;String, User&gt;(userSetSize);<a name="line.70"></a>
<FONT color="green">071</FONT>      <a name="line.71"></a>
<FONT color="green">072</FONT>      /** The in-memory repository of User XML strings, keyed by User. */<a name="line.72"></a>
<FONT color="green">073</FONT>      private Map&lt;User, String&gt; user2xml = new HashMap&lt;User, String&gt;(userSetSize);<a name="line.73"></a>
<FONT color="green">074</FONT>      <a name="line.74"></a>
<FONT color="green">075</FONT>      /** The in-memory repository of UserRef XML strings, keyed by User. */<a name="line.75"></a>
<FONT color="green">076</FONT>      private Map&lt;User, String&gt; user2ref = new HashMap&lt;User, String&gt;(userSetSize);<a name="line.76"></a>
<FONT color="green">077</FONT>      <a name="line.77"></a>
<FONT color="green">078</FONT>      /** <a name="line.78"></a>
<FONT color="green">079</FONT>       * The constructor for UserManagers. <a name="line.79"></a>
<FONT color="green">080</FONT>       * @param server The Server instance associated with this UserManager. <a name="line.80"></a>
<FONT color="green">081</FONT>       */<a name="line.81"></a>
<FONT color="green">082</FONT>      public UserManager(Server server) {<a name="line.82"></a>
<FONT color="green">083</FONT>        this.server = server;<a name="line.83"></a>
<FONT color="green">084</FONT>        this.dbManager = (DbManager)this.server.getContext().getAttributes().get("DbManager");<a name="line.84"></a>
<FONT color="green">085</FONT>        try {<a name="line.85"></a>
<FONT color="green">086</FONT>          this.jaxbContext = <a name="line.86"></a>
<FONT color="green">087</FONT>            JAXBContext.newInstance(<a name="line.87"></a>
<FONT color="green">088</FONT>                org.hackystat.sensorbase.resource.users.jaxb.ObjectFactory.class);<a name="line.88"></a>
<FONT color="green">089</FONT>          loadDefaultUsers(); //NOPMD it's throwing a false warning. <a name="line.89"></a>
<FONT color="green">090</FONT>          initializeCache();  //NOPMD <a name="line.90"></a>
<FONT color="green">091</FONT>          initializeAdminUser(); //NOPMD<a name="line.91"></a>
<FONT color="green">092</FONT>        }<a name="line.92"></a>
<FONT color="green">093</FONT>        catch (Exception e) {<a name="line.93"></a>
<FONT color="green">094</FONT>          String msg = "Exception during UserManager initialization processing";<a name="line.94"></a>
<FONT color="green">095</FONT>          server.getLogger().warning(msg + "\n" + StackTrace.toString(e));<a name="line.95"></a>
<FONT color="green">096</FONT>          throw new RuntimeException(msg, e);<a name="line.96"></a>
<FONT color="green">097</FONT>        }<a name="line.97"></a>
<FONT color="green">098</FONT>      }<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>      /**<a name="line.100"></a>
<FONT color="green">101</FONT>       * Loads the default Users from the defaults file and adds them to the database. <a name="line.101"></a>
<FONT color="green">102</FONT>       * @throws Exception If problems occur. <a name="line.102"></a>
<FONT color="green">103</FONT>       */<a name="line.103"></a>
<FONT color="green">104</FONT>      private final void loadDefaultUsers() throws Exception {<a name="line.104"></a>
<FONT color="green">105</FONT>        // Get the default User definitions from the XML defaults file. <a name="line.105"></a>
<FONT color="green">106</FONT>        File defaultsFile = findDefaultsFile();<a name="line.106"></a>
<FONT color="green">107</FONT>        // Add these users to the database if we've found a default file. <a name="line.107"></a>
<FONT color="green">108</FONT>        if (defaultsFile.exists()) {<a name="line.108"></a>
<FONT color="green">109</FONT>          server.getLogger().info("Loading User defaults from " + defaultsFile.getPath()); <a name="line.109"></a>
<FONT color="green">110</FONT>          Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();<a name="line.110"></a>
<FONT color="green">111</FONT>          Users users = (Users) unmarshaller.unmarshal(defaultsFile);<a name="line.111"></a>
<FONT color="green">112</FONT>          for (User user : users.getUser()) {<a name="line.112"></a>
<FONT color="green">113</FONT>            user.setLastMod(Tstamp.makeTimestamp());<a name="line.113"></a>
<FONT color="green">114</FONT>            this.dbManager.storeUser(user, this.makeUser(user), this.makeUserRefString(user));<a name="line.114"></a>
<FONT color="green">115</FONT>          }<a name="line.115"></a>
<FONT color="green">116</FONT>        }<a name="line.116"></a>
<FONT color="green">117</FONT>      }<a name="line.117"></a>
<FONT color="green">118</FONT>      <a name="line.118"></a>
<FONT color="green">119</FONT>      /** Read in all Users from the database and initialize the in-memory cache. */<a name="line.119"></a>
<FONT color="green">120</FONT>      private final void initializeCache() {<a name="line.120"></a>
<FONT color="green">121</FONT>        try {<a name="line.121"></a>
<FONT color="green">122</FONT>          UserIndex index = makeUserIndex(this.dbManager.getUserIndex());<a name="line.122"></a>
<FONT color="green">123</FONT>          for (UserRef ref : index.getUserRef()) {<a name="line.123"></a>
<FONT color="green">124</FONT>            String email = ref.getEmail();<a name="line.124"></a>
<FONT color="green">125</FONT>            String userString = this.dbManager.getUser(email);<a name="line.125"></a>
<FONT color="green">126</FONT>            User user = makeUser(userString);<a name="line.126"></a>
<FONT color="green">127</FONT>            this.updateCache(user);<a name="line.127"></a>
<FONT color="green">128</FONT>          }<a name="line.128"></a>
<FONT color="green">129</FONT>        }<a name="line.129"></a>
<FONT color="green">130</FONT>        catch (Exception e) {<a name="line.130"></a>
<FONT color="green">131</FONT>          server.getLogger().warning("Failed to initialize users " + StackTrace.toString(e));<a name="line.131"></a>
<FONT color="green">132</FONT>        }<a name="line.132"></a>
<FONT color="green">133</FONT>      }<a name="line.133"></a>
<FONT color="green">134</FONT>      <a name="line.134"></a>
<FONT color="green">135</FONT>      <a name="line.135"></a>
<FONT color="green">136</FONT>      /**<a name="line.136"></a>
<FONT color="green">137</FONT>       * Ensures a User exists with the admin role given the data in the sensorbase.properties file. <a name="line.137"></a>
<FONT color="green">138</FONT>       * The admin password will be reset to what was in the sensorbase.properties file. <a name="line.138"></a>
<FONT color="green">139</FONT>       * Note that the "admin" role is managed non-persistently: it is read into the cache from<a name="line.139"></a>
<FONT color="green">140</FONT>       * the sensorbase.properties at startup, and any persistently stored values for it are <a name="line.140"></a>
<FONT color="green">141</FONT>       * ignored. This, of course, will eventually cause confusion. <a name="line.141"></a>
<FONT color="green">142</FONT>       * @throws Exception if problems creating the XML string representations of the admin user.  <a name="line.142"></a>
<FONT color="green">143</FONT>       */<a name="line.143"></a>
<FONT color="green">144</FONT>      private final void initializeAdminUser() throws Exception {<a name="line.144"></a>
<FONT color="green">145</FONT>        String adminEmail = server.getServerProperties().get(ADMIN_EMAIL_KEY);<a name="line.145"></a>
<FONT color="green">146</FONT>        String adminPassword = server.getServerProperties().get(ADMIN_PASSWORD_KEY);<a name="line.146"></a>
<FONT color="green">147</FONT>        // First, clear any existing Admin role property.<a name="line.147"></a>
<FONT color="green">148</FONT>        for (User user : this.email2user.values()) {<a name="line.148"></a>
<FONT color="green">149</FONT>          user.setRole("basic");<a name="line.149"></a>
<FONT color="green">150</FONT>        }<a name="line.150"></a>
<FONT color="green">151</FONT>        // Now define the admin user with the admin property.<a name="line.151"></a>
<FONT color="green">152</FONT>        if (this.email2user.containsKey(adminEmail)) {<a name="line.152"></a>
<FONT color="green">153</FONT>          User user = this.email2user.get(adminEmail);<a name="line.153"></a>
<FONT color="green">154</FONT>          user.setPassword(adminPassword);<a name="line.154"></a>
<FONT color="green">155</FONT>          user.setRole("admin");<a name="line.155"></a>
<FONT color="green">156</FONT>        }<a name="line.156"></a>
<FONT color="green">157</FONT>        else {<a name="line.157"></a>
<FONT color="green">158</FONT>          User admin = new User();<a name="line.158"></a>
<FONT color="green">159</FONT>          admin.setEmail(adminEmail);<a name="line.159"></a>
<FONT color="green">160</FONT>          admin.setPassword(adminPassword);<a name="line.160"></a>
<FONT color="green">161</FONT>          admin.setRole("admin");<a name="line.161"></a>
<FONT color="green">162</FONT>          this.updateCache(admin);<a name="line.162"></a>
<FONT color="green">163</FONT>        }<a name="line.163"></a>
<FONT color="green">164</FONT>      }<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>      /**<a name="line.166"></a>
<FONT color="green">167</FONT>       * Updates the in-memory cache with information about this User. <a name="line.167"></a>
<FONT color="green">168</FONT>       * @param user The user to be added to the cache.<a name="line.168"></a>
<FONT color="green">169</FONT>       * @throws Exception If problems occur updating the cache. <a name="line.169"></a>
<FONT color="green">170</FONT>       */<a name="line.170"></a>
<FONT color="green">171</FONT>      private final void updateCache(User user) throws Exception {<a name="line.171"></a>
<FONT color="green">172</FONT>        if (user.getLastMod() == null) {<a name="line.172"></a>
<FONT color="green">173</FONT>          user.setLastMod(Tstamp.makeTimestamp());<a name="line.173"></a>
<FONT color="green">174</FONT>        }<a name="line.174"></a>
<FONT color="green">175</FONT>        updateCache(user, this.makeUser(user), this.makeUserRefString(user));<a name="line.175"></a>
<FONT color="green">176</FONT>      }<a name="line.176"></a>
<FONT color="green">177</FONT>      <a name="line.177"></a>
<FONT color="green">178</FONT>      /**<a name="line.178"></a>
<FONT color="green">179</FONT>       * Updates the cache given all the User representations.<a name="line.179"></a>
<FONT color="green">180</FONT>       * @param user The User.<a name="line.180"></a>
<FONT color="green">181</FONT>       * @param userXml The User as an XML string. <a name="line.181"></a>
<FONT color="green">182</FONT>       * @param userRef The User as an XML reference. <a name="line.182"></a>
<FONT color="green">183</FONT>       */<a name="line.183"></a>
<FONT color="green">184</FONT>      private void updateCache(User user, String userXml, String userRef) {<a name="line.184"></a>
<FONT color="green">185</FONT>        this.email2user.put(user.getEmail(), user);<a name="line.185"></a>
<FONT color="green">186</FONT>        this.user2xml.put(user, userXml);<a name="line.186"></a>
<FONT color="green">187</FONT>        this.user2ref.put(user, userRef);<a name="line.187"></a>
<FONT color="green">188</FONT>      }<a name="line.188"></a>
<FONT color="green">189</FONT>      <a name="line.189"></a>
<FONT color="green">190</FONT>      /**<a name="line.190"></a>
<FONT color="green">191</FONT>       * Checks ServerProperties for the XML_DIR property.<a name="line.191"></a>
<FONT color="green">192</FONT>       * If this property is null, returns the File for ./xml/defaults/sensordatatypes.defaults.xml.<a name="line.192"></a>
<FONT color="green">193</FONT>       * @return The File instance (which might not point to an existing file.)<a name="line.193"></a>
<FONT color="green">194</FONT>       */<a name="line.194"></a>
<FONT color="green">195</FONT>      private File findDefaultsFile() {<a name="line.195"></a>
<FONT color="green">196</FONT>        String defaultsPath = "/defaults/users.defaults.xml";<a name="line.196"></a>
<FONT color="green">197</FONT>        String xmlDir = server.getServerProperties().get(XML_DIR_KEY);<a name="line.197"></a>
<FONT color="green">198</FONT>        return (xmlDir == null) ?<a name="line.198"></a>
<FONT color="green">199</FONT>            new File (System.getProperty("user.dir") + "/xml" + defaultsPath) :<a name="line.199"></a>
<FONT color="green">200</FONT>              new File (xmlDir + defaultsPath);<a name="line.200"></a>
<FONT color="green">201</FONT>      }<a name="line.201"></a>
<FONT color="green">202</FONT>    <a name="line.202"></a>
<FONT color="green">203</FONT>      /**<a name="line.203"></a>
<FONT color="green">204</FONT>       * Returns the XML string containing the UserIndex with all defined Users.<a name="line.204"></a>
<FONT color="green">205</FONT>       * Uses the in-memory cache of UserRef strings.  <a name="line.205"></a>
<FONT color="green">206</FONT>       * @return The XML string providing an index to all current Users.<a name="line.206"></a>
<FONT color="green">207</FONT>       */<a name="line.207"></a>
<FONT color="green">208</FONT>      public synchronized String getUserIndex() {<a name="line.208"></a>
<FONT color="green">209</FONT>        StringBuilder builder = new StringBuilder(512);<a name="line.209"></a>
<FONT color="green">210</FONT>        builder.append(userIndexOpenTag);<a name="line.210"></a>
<FONT color="green">211</FONT>        for (String ref : this.user2ref.values()) {<a name="line.211"></a>
<FONT color="green">212</FONT>          builder.append(ref);<a name="line.212"></a>
<FONT color="green">213</FONT>        }<a name="line.213"></a>
<FONT color="green">214</FONT>        builder.append(userIndexCloseTag);<a name="line.214"></a>
<FONT color="green">215</FONT>        return builder.toString();<a name="line.215"></a>
<FONT color="green">216</FONT>      }<a name="line.216"></a>
<FONT color="green">217</FONT>      <a name="line.217"></a>
<FONT color="green">218</FONT>      /**<a name="line.218"></a>
<FONT color="green">219</FONT>       * Updates the Manager with this User. Any old definition is overwritten.<a name="line.219"></a>
<FONT color="green">220</FONT>       * @param user The User.<a name="line.220"></a>
<FONT color="green">221</FONT>       */<a name="line.221"></a>
<FONT color="green">222</FONT>      public synchronized void putUser(User user) {<a name="line.222"></a>
<FONT color="green">223</FONT>        try {<a name="line.223"></a>
<FONT color="green">224</FONT>          user.setLastMod(Tstamp.makeTimestamp());<a name="line.224"></a>
<FONT color="green">225</FONT>          String xmlUser =  this.makeUser(user);<a name="line.225"></a>
<FONT color="green">226</FONT>          String xmlRef =  this.makeUserRefString(user);<a name="line.226"></a>
<FONT color="green">227</FONT>          this.updateCache(user, xmlUser, xmlRef);<a name="line.227"></a>
<FONT color="green">228</FONT>          this.dbManager.storeUser(user, xmlUser, xmlRef);<a name="line.228"></a>
<FONT color="green">229</FONT>        }<a name="line.229"></a>
<FONT color="green">230</FONT>        catch (Exception e) {<a name="line.230"></a>
<FONT color="green">231</FONT>          server.getLogger().warning("Failed to put User" + StackTrace.toString(e));<a name="line.231"></a>
<FONT color="green">232</FONT>        }<a name="line.232"></a>
<FONT color="green">233</FONT>      }<a name="line.233"></a>
<FONT color="green">234</FONT>      <a name="line.234"></a>
<FONT color="green">235</FONT>    <a name="line.235"></a>
<FONT color="green">236</FONT>      /**<a name="line.236"></a>
<FONT color="green">237</FONT>       * Ensures that the passed User is no longer present in this Manager. <a name="line.237"></a>
<FONT color="green">238</FONT>       * @param email The email address of the User to remove if currently present.<a name="line.238"></a>
<FONT color="green">239</FONT>       */<a name="line.239"></a>
<FONT color="green">240</FONT>      public synchronized void deleteUser(String email) {<a name="line.240"></a>
<FONT color="green">241</FONT>        User user = this.email2user.get(email);<a name="line.241"></a>
<FONT color="green">242</FONT>        if (user != null) {<a name="line.242"></a>
<FONT color="green">243</FONT>          this.email2user.remove(email);<a name="line.243"></a>
<FONT color="green">244</FONT>          this.user2xml.remove(user);<a name="line.244"></a>
<FONT color="green">245</FONT>          this.user2ref.remove(user);<a name="line.245"></a>
<FONT color="green">246</FONT>        }<a name="line.246"></a>
<FONT color="green">247</FONT>        this.dbManager.deleteUser(email);<a name="line.247"></a>
<FONT color="green">248</FONT>      }<a name="line.248"></a>
<FONT color="green">249</FONT>      <a name="line.249"></a>
<FONT color="green">250</FONT>    <a name="line.250"></a>
<FONT color="green">251</FONT>      /**<a name="line.251"></a>
<FONT color="green">252</FONT>       * Returns the User associated with this email address if they are currently registered, or null<a name="line.252"></a>
<FONT color="green">253</FONT>       * if not found.<a name="line.253"></a>
<FONT color="green">254</FONT>       * @param email The email address<a name="line.254"></a>
<FONT color="green">255</FONT>       * @return The User, or null if not found.<a name="line.255"></a>
<FONT color="green">256</FONT>       */<a name="line.256"></a>
<FONT color="green">257</FONT>      public synchronized User getUser(String email) {<a name="line.257"></a>
<FONT color="green">258</FONT>        return (email == null) ? null : email2user.get(email);<a name="line.258"></a>
<FONT color="green">259</FONT>      }<a name="line.259"></a>
<FONT color="green">260</FONT>      <a name="line.260"></a>
<FONT color="green">261</FONT>      /**<a name="line.261"></a>
<FONT color="green">262</FONT>       * Returns the User Xml String associated with this email address if they are registered, or <a name="line.262"></a>
<FONT color="green">263</FONT>       * null if user not found.<a name="line.263"></a>
<FONT color="green">264</FONT>       * @param email The email address<a name="line.264"></a>
<FONT color="green">265</FONT>       * @return The User XML string, or null if not found.<a name="line.265"></a>
<FONT color="green">266</FONT>       */<a name="line.266"></a>
<FONT color="green">267</FONT>      public synchronized String getUserString(String email) {<a name="line.267"></a>
<FONT color="green">268</FONT>        User user = email2user.get(email);<a name="line.268"></a>
<FONT color="green">269</FONT>        return (user == null) ? null : user2xml.get(user);<a name="line.269"></a>
<FONT color="green">270</FONT>      }<a name="line.270"></a>
<FONT color="green">271</FONT>      <a name="line.271"></a>
<FONT color="green">272</FONT>      /**<a name="line.272"></a>
<FONT color="green">273</FONT>       * Updates the given User with the passed Properties. <a name="line.273"></a>
<FONT color="green">274</FONT>       * @param user The User whose properties are to be updated.<a name="line.274"></a>
<FONT color="green">275</FONT>       * @param properties The Properties. <a name="line.275"></a>
<FONT color="green">276</FONT>       */<a name="line.276"></a>
<FONT color="green">277</FONT>      public synchronized void updateProperties(User user, Properties properties) {<a name="line.277"></a>
<FONT color="green">278</FONT>        for (Property property : properties.getProperty()) {<a name="line.278"></a>
<FONT color="green">279</FONT>          user.getProperties().getProperty().add(property);<a name="line.279"></a>
<FONT color="green">280</FONT>        }<a name="line.280"></a>
<FONT color="green">281</FONT>        this.putUser(user);<a name="line.281"></a>
<FONT color="green">282</FONT>      }<a name="line.282"></a>
<FONT color="green">283</FONT>      <a name="line.283"></a>
<FONT color="green">284</FONT>      /**<a name="line.284"></a>
<FONT color="green">285</FONT>       * Returns a set containing the current User instances. <a name="line.285"></a>
<FONT color="green">286</FONT>       * For thread safety, a fresh Set of Users is built each time this is called. <a name="line.286"></a>
<FONT color="green">287</FONT>       * @return A Set containing the current Users. <a name="line.287"></a>
<FONT color="green">288</FONT>       */<a name="line.288"></a>
<FONT color="green">289</FONT>      public synchronized Set&lt;User&gt; getUsers() {<a name="line.289"></a>
<FONT color="green">290</FONT>        Set&lt;User&gt; userSet = new HashSet&lt;User&gt;(userSetSize); <a name="line.290"></a>
<FONT color="green">291</FONT>        userSet.addAll(this.email2user.values());<a name="line.291"></a>
<FONT color="green">292</FONT>        return userSet;<a name="line.292"></a>
<FONT color="green">293</FONT>      }<a name="line.293"></a>
<FONT color="green">294</FONT>      <a name="line.294"></a>
<FONT color="green">295</FONT>      /**<a name="line.295"></a>
<FONT color="green">296</FONT>       * Returns true if the User as identified by their email address is known to this Manager.<a name="line.296"></a>
<FONT color="green">297</FONT>       * @param email The email address of the User of interest.<a name="line.297"></a>
<FONT color="green">298</FONT>       * @return True if found in this Manager.<a name="line.298"></a>
<FONT color="green">299</FONT>       */<a name="line.299"></a>
<FONT color="green">300</FONT>      public synchronized boolean isUser(String email) {<a name="line.300"></a>
<FONT color="green">301</FONT>        return (email != null) &amp;&amp; email2user.containsKey(email);<a name="line.301"></a>
<FONT color="green">302</FONT>      }<a name="line.302"></a>
<FONT color="green">303</FONT>      <a name="line.303"></a>
<FONT color="green">304</FONT>      /**<a name="line.304"></a>
<FONT color="green">305</FONT>       * Returns true if the User as identified by their email address and password<a name="line.305"></a>
<FONT color="green">306</FONT>       * is known to this Manager.<a name="line.306"></a>
<FONT color="green">307</FONT>       * @param email The email address of the User of interest.<a name="line.307"></a>
<FONT color="green">308</FONT>       * @param password The password of this user.<a name="line.308"></a>
<FONT color="green">309</FONT>       * @return True if found in this Manager.<a name="line.309"></a>
<FONT color="green">310</FONT>       */<a name="line.310"></a>
<FONT color="green">311</FONT>      public synchronized boolean isUser(String email, String password) {<a name="line.311"></a>
<FONT color="green">312</FONT>        User user = this.email2user.get(email);<a name="line.312"></a>
<FONT color="green">313</FONT>        return (user != null) &amp;&amp; (password != null) &amp;&amp; (password.equals(user.getPassword()));<a name="line.313"></a>
<FONT color="green">314</FONT>      }<a name="line.314"></a>
<FONT color="green">315</FONT>      <a name="line.315"></a>
<FONT color="green">316</FONT>      /**<a name="line.316"></a>
<FONT color="green">317</FONT>       * Returns true if email is a defined User with Admin privileges. <a name="line.317"></a>
<FONT color="green">318</FONT>       * @param email An email address. <a name="line.318"></a>
<FONT color="green">319</FONT>       * @return True if email is a User with Admin privileges. <a name="line.319"></a>
<FONT color="green">320</FONT>       */<a name="line.320"></a>
<FONT color="green">321</FONT>      public synchronized boolean isAdmin(String email) {<a name="line.321"></a>
<FONT color="green">322</FONT>        return (email != null) &amp;&amp;<a name="line.322"></a>
<FONT color="green">323</FONT>               email2user.containsKey(email) &amp;&amp; <a name="line.323"></a>
<FONT color="green">324</FONT>               email.equals(server.getServerProperties().get(ADMIN_EMAIL_KEY));<a name="line.324"></a>
<FONT color="green">325</FONT>      }<a name="line.325"></a>
<FONT color="green">326</FONT>      <a name="line.326"></a>
<FONT color="green">327</FONT>      /**<a name="line.327"></a>
<FONT color="green">328</FONT>       * Returns true if the passed user is a test user.<a name="line.328"></a>
<FONT color="green">329</FONT>       * This is defined as a User whose email address uses the TEST_DOMAIN.  <a name="line.329"></a>
<FONT color="green">330</FONT>       * @param user The user. <a name="line.330"></a>
<FONT color="green">331</FONT>       * @return True if the user is a test user. <a name="line.331"></a>
<FONT color="green">332</FONT>       */<a name="line.332"></a>
<FONT color="green">333</FONT>      public synchronized boolean isTestUser(User user) {<a name="line.333"></a>
<FONT color="green">334</FONT>        return user.getEmail().endsWith(server.getServerProperties().get(TEST_DOMAIN_KEY));<a name="line.334"></a>
<FONT color="green">335</FONT>      }<a name="line.335"></a>
<FONT color="green">336</FONT>      <a name="line.336"></a>
<FONT color="green">337</FONT>      /** <a name="line.337"></a>
<FONT color="green">338</FONT>       * Registers a User, given their email address.<a name="line.338"></a>
<FONT color="green">339</FONT>       * If a User with the passed email address exists, then return the previously registered User.<a name="line.339"></a>
<FONT color="green">340</FONT>       * Otherwise create a new User and return it.<a name="line.340"></a>
<FONT color="green">341</FONT>       * If the email address ends with the test domain, then the password will be the email.<a name="line.341"></a>
<FONT color="green">342</FONT>       * Otherwise, a unique, randomly generated 12 character key is generated as the password. <a name="line.342"></a>
<FONT color="green">343</FONT>       * Defines the Default Project for each new user. <a name="line.343"></a>
<FONT color="green">344</FONT>       * @param email The email address for the user. <a name="line.344"></a>
<FONT color="green">345</FONT>       * @return The retrieved or newly created User.<a name="line.345"></a>
<FONT color="green">346</FONT>       */<a name="line.346"></a>
<FONT color="green">347</FONT>      public synchronized User registerUser(String email) {<a name="line.347"></a>
<FONT color="green">348</FONT>        // registering happens rarely, so we'll just iterate through the userMap.<a name="line.348"></a>
<FONT color="green">349</FONT>        for (User user : this.email2user.values()) {<a name="line.349"></a>
<FONT color="green">350</FONT>          if (user.getEmail().equals(email)) {<a name="line.350"></a>
<FONT color="green">351</FONT>            return user;<a name="line.351"></a>
<FONT color="green">352</FONT>          }<a name="line.352"></a>
<FONT color="green">353</FONT>        }<a name="line.353"></a>
<FONT color="green">354</FONT>        // if we got here, we need to create a new User.<a name="line.354"></a>
<FONT color="green">355</FONT>        User user = new User();<a name="line.355"></a>
<FONT color="green">356</FONT>        user.setEmail(email);<a name="line.356"></a>
<FONT color="green">357</FONT>        user.setProperties(new Properties());<a name="line.357"></a>
<FONT color="green">358</FONT>        // Password is either their Email in the case of a test user, or the randomly generated string.<a name="line.358"></a>
<FONT color="green">359</FONT>        String password = <a name="line.359"></a>
<FONT color="green">360</FONT>          email.endsWith(server.getServerProperties().get(TEST_DOMAIN_KEY)) ? <a name="line.360"></a>
<FONT color="green">361</FONT>              email : PasswordGenerator.make();<a name="line.361"></a>
<FONT color="green">362</FONT>        user.setPassword(password);<a name="line.362"></a>
<FONT color="green">363</FONT>        this.putUser(user);<a name="line.363"></a>
<FONT color="green">364</FONT>        return user;<a name="line.364"></a>
<FONT color="green">365</FONT>      } <a name="line.365"></a>
<FONT color="green">366</FONT>      <a name="line.366"></a>
<FONT color="green">367</FONT>      /**<a name="line.367"></a>
<FONT color="green">368</FONT>       * Takes a String encoding of a Properties in XML format and converts it to an instance. <a name="line.368"></a>
<FONT color="green">369</FONT>       * <a name="line.369"></a>
<FONT color="green">370</FONT>       * @param xmlString The XML string representing a Properties.<a name="line.370"></a>
<FONT color="green">371</FONT>       * @return The corresponding Properties instance. <a name="line.371"></a>
<FONT color="green">372</FONT>       * @throws Exception If problems occur during unmarshalling.<a name="line.372"></a>
<FONT color="green">373</FONT>       */<a name="line.373"></a>
<FONT color="green">374</FONT>      public final synchronized Properties makeProperties(String xmlString) throws Exception {<a name="line.374"></a>
<FONT color="green">375</FONT>        Unmarshaller unmarshaller = this.jaxbContext.createUnmarshaller();<a name="line.375"></a>
<FONT color="green">376</FONT>        return (Properties)unmarshaller.unmarshal(new StringReader(xmlString));<a name="line.376"></a>
<FONT color="green">377</FONT>      }<a name="line.377"></a>
<FONT color="green">378</FONT>      <a name="line.378"></a>
<FONT color="green">379</FONT>      /**<a name="line.379"></a>
<FONT color="green">380</FONT>       * Takes a String encoding of a User in XML format and converts it to an instance. <a name="line.380"></a>
<FONT color="green">381</FONT>       * <a name="line.381"></a>
<FONT color="green">382</FONT>       * @param xmlString The XML string representing a User<a name="line.382"></a>
<FONT color="green">383</FONT>       * @return The corresponding User instance. <a name="line.383"></a>
<FONT color="green">384</FONT>       * @throws Exception If problems occur during unmarshalling.<a name="line.384"></a>
<FONT color="green">385</FONT>       */<a name="line.385"></a>
<FONT color="green">386</FONT>      public final synchronized User makeUser(String xmlString) throws Exception {<a name="line.386"></a>
<FONT color="green">387</FONT>        Unmarshaller unmarshaller = this.jaxbContext.createUnmarshaller();<a name="line.387"></a>
<FONT color="green">388</FONT>        return (User)unmarshaller.unmarshal(new StringReader(xmlString));<a name="line.388"></a>
<FONT color="green">389</FONT>      }<a name="line.389"></a>
<FONT color="green">390</FONT>      <a name="line.390"></a>
<FONT color="green">391</FONT>      /**<a name="line.391"></a>
<FONT color="green">392</FONT>       * Takes a String encoding of a UserIndex in XML format and converts it to an instance. <a name="line.392"></a>
<FONT color="green">393</FONT>       * <a name="line.393"></a>
<FONT color="green">394</FONT>       * @param xmlString The XML string representing a UserIndex.<a name="line.394"></a>
<FONT color="green">395</FONT>       * @return The corresponding UserIndex instance. <a name="line.395"></a>
<FONT color="green">396</FONT>       * @throws Exception If problems occur during unmarshalling.<a name="line.396"></a>
<FONT color="green">397</FONT>       */<a name="line.397"></a>
<FONT color="green">398</FONT>      public final synchronized UserIndex makeUserIndex(String xmlString) <a name="line.398"></a>
<FONT color="green">399</FONT>      throws Exception {<a name="line.399"></a>
<FONT color="green">400</FONT>        Unmarshaller unmarshaller = this.jaxbContext.createUnmarshaller();<a name="line.400"></a>
<FONT color="green">401</FONT>        return (UserIndex)unmarshaller.unmarshal(new StringReader(xmlString));<a name="line.401"></a>
<FONT color="green">402</FONT>      }<a name="line.402"></a>
<FONT color="green">403</FONT>      <a name="line.403"></a>
<FONT color="green">404</FONT>      /**<a name="line.404"></a>
<FONT color="green">405</FONT>       * Returns the passed User instance as a String encoding of its XML representation.<a name="line.405"></a>
<FONT color="green">406</FONT>       * Final because it's called in constructor.<a name="line.406"></a>
<FONT color="green">407</FONT>       * @param user The User instance. <a name="line.407"></a>
<FONT color="green">408</FONT>       * @return The XML String representation.<a name="line.408"></a>
<FONT color="green">409</FONT>       * @throws Exception If problems occur during translation. <a name="line.409"></a>
<FONT color="green">410</FONT>       */<a name="line.410"></a>
<FONT color="green">411</FONT>      public final synchronized String makeUser (User user) throws Exception {<a name="line.411"></a>
<FONT color="green">412</FONT>        Marshaller marshaller = jaxbContext.createMarshaller(); <a name="line.412"></a>
<FONT color="green">413</FONT>        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();<a name="line.413"></a>
<FONT color="green">414</FONT>        dbf.setNamespaceAware(true);<a name="line.414"></a>
<FONT color="green">415</FONT>        DocumentBuilder documentBuilder = dbf.newDocumentBuilder();<a name="line.415"></a>
<FONT color="green">416</FONT>        Document doc = documentBuilder.newDocument();<a name="line.416"></a>
<FONT color="green">417</FONT>        marshaller.marshal(user, doc);<a name="line.417"></a>
<FONT color="green">418</FONT>        DOMSource domSource = new DOMSource(doc);<a name="line.418"></a>
<FONT color="green">419</FONT>        StringWriter writer = new StringWriter();<a name="line.419"></a>
<FONT color="green">420</FONT>        StreamResult result = new StreamResult(writer);<a name="line.420"></a>
<FONT color="green">421</FONT>        TransformerFactory tf = TransformerFactory.newInstance();<a name="line.421"></a>
<FONT color="green">422</FONT>        Transformer transformer = tf.newTransformer();<a name="line.422"></a>
<FONT color="green">423</FONT>        transformer.transform(domSource, result);<a name="line.423"></a>
<FONT color="green">424</FONT>        String xmlString = writer.toString();<a name="line.424"></a>
<FONT color="green">425</FONT>        // Now remove the processing instruction.  This approach seems like a total hack.<a name="line.425"></a>
<FONT color="green">426</FONT>        xmlString = xmlString.substring(xmlString.indexOf('&gt;') + 1);<a name="line.426"></a>
<FONT color="green">427</FONT>        return xmlString;<a name="line.427"></a>
<FONT color="green">428</FONT>      }<a name="line.428"></a>
<FONT color="green">429</FONT>      <a name="line.429"></a>
<FONT color="green">430</FONT>      /**<a name="line.430"></a>
<FONT color="green">431</FONT>       * Returns the passed Properties instance as a String encoding of its XML representation.<a name="line.431"></a>
<FONT color="green">432</FONT>       * @param properties The Properties instance. <a name="line.432"></a>
<FONT color="green">433</FONT>       * @return The XML String representation.<a name="line.433"></a>
<FONT color="green">434</FONT>       * @throws Exception If problems occur during translation. <a name="line.434"></a>
<FONT color="green">435</FONT>       */<a name="line.435"></a>
<FONT color="green">436</FONT>      public synchronized String makeProperties (Properties properties) throws Exception {<a name="line.436"></a>
<FONT color="green">437</FONT>        Marshaller marshaller = jaxbContext.createMarshaller(); <a name="line.437"></a>
<FONT color="green">438</FONT>        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();<a name="line.438"></a>
<FONT color="green">439</FONT>        dbf.setNamespaceAware(true);<a name="line.439"></a>
<FONT color="green">440</FONT>        DocumentBuilder documentBuilder = dbf.newDocumentBuilder();<a name="line.440"></a>
<FONT color="green">441</FONT>        Document doc = documentBuilder.newDocument();<a name="line.441"></a>
<FONT color="green">442</FONT>        marshaller.marshal(properties, doc);<a name="line.442"></a>
<FONT color="green">443</FONT>        DOMSource domSource = new DOMSource(doc);<a name="line.443"></a>
<FONT color="green">444</FONT>        StringWriter writer = new StringWriter();<a name="line.444"></a>
<FONT color="green">445</FONT>        StreamResult result = new StreamResult(writer);<a name="line.445"></a>
<FONT color="green">446</FONT>        TransformerFactory tf = TransformerFactory.newInstance();<a name="line.446"></a>
<FONT color="green">447</FONT>        Transformer transformer = tf.newTransformer();<a name="line.447"></a>
<FONT color="green">448</FONT>        transformer.transform(domSource, result);<a name="line.448"></a>
<FONT color="green">449</FONT>        String xmlString = writer.toString();<a name="line.449"></a>
<FONT color="green">450</FONT>        // Now remove the processing instruction.  This approach seems like a total hack.<a name="line.450"></a>
<FONT color="green">451</FONT>        xmlString = xmlString.substring(xmlString.indexOf('&gt;') + 1);<a name="line.451"></a>
<FONT color="green">452</FONT>        return xmlString;<a name="line.452"></a>
<FONT color="green">453</FONT>      }<a name="line.453"></a>
<FONT color="green">454</FONT>    <a name="line.454"></a>
<FONT color="green">455</FONT>      /**<a name="line.455"></a>
<FONT color="green">456</FONT>       * Returns the passed User instance as a String encoding of its XML representation <a name="line.456"></a>
<FONT color="green">457</FONT>       * as a UserRef object.<a name="line.457"></a>
<FONT color="green">458</FONT>       * Final because it's called in constructor.<a name="line.458"></a>
<FONT color="green">459</FONT>       * @param user The User instance. <a name="line.459"></a>
<FONT color="green">460</FONT>       * @return The XML String representation of it as a UserRef<a name="line.460"></a>
<FONT color="green">461</FONT>       * @throws Exception If problems occur during translation. <a name="line.461"></a>
<FONT color="green">462</FONT>       */<a name="line.462"></a>
<FONT color="green">463</FONT>      public final synchronized String makeUserRefString (User user) <a name="line.463"></a>
<FONT color="green">464</FONT>      throws Exception {<a name="line.464"></a>
<FONT color="green">465</FONT>        UserRef ref = makeUserRef(user);<a name="line.465"></a>
<FONT color="green">466</FONT>        Marshaller marshaller = jaxbContext.createMarshaller(); <a name="line.466"></a>
<FONT color="green">467</FONT>        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();<a name="line.467"></a>
<FONT color="green">468</FONT>        dbf.setNamespaceAware(true);<a name="line.468"></a>
<FONT color="green">469</FONT>        DocumentBuilder documentBuilder = dbf.newDocumentBuilder();<a name="line.469"></a>
<FONT color="green">470</FONT>        Document doc = documentBuilder.newDocument();<a name="line.470"></a>
<FONT color="green">471</FONT>        marshaller.marshal(ref, doc);<a name="line.471"></a>
<FONT color="green">472</FONT>        DOMSource domSource = new DOMSource(doc);<a name="line.472"></a>
<FONT color="green">473</FONT>        StringWriter writer = new StringWriter();<a name="line.473"></a>
<FONT color="green">474</FONT>        StreamResult result = new StreamResult(writer);<a name="line.474"></a>
<FONT color="green">475</FONT>        TransformerFactory tf = TransformerFactory.newInstance();<a name="line.475"></a>
<FONT color="green">476</FONT>        Transformer transformer = tf.newTransformer();<a name="line.476"></a>
<FONT color="green">477</FONT>        transformer.transform(domSource, result);<a name="line.477"></a>
<FONT color="green">478</FONT>        String xmlString = writer.toString();<a name="line.478"></a>
<FONT color="green">479</FONT>        // Now remove the processing instruction.  This approach seems like a total hack.<a name="line.479"></a>
<FONT color="green">480</FONT>        xmlString = xmlString.substring(xmlString.indexOf('&gt;') + 1);<a name="line.480"></a>
<FONT color="green">481</FONT>        return xmlString;<a name="line.481"></a>
<FONT color="green">482</FONT>      }<a name="line.482"></a>
<FONT color="green">483</FONT>      <a name="line.483"></a>
<FONT color="green">484</FONT>      /**<a name="line.484"></a>
<FONT color="green">485</FONT>       * Returns a UserRef instance constructed from a User instance.<a name="line.485"></a>
<FONT color="green">486</FONT>       * @param user The User instance. <a name="line.486"></a>
<FONT color="green">487</FONT>       * @return A UserRef instance. <a name="line.487"></a>
<FONT color="green">488</FONT>       */<a name="line.488"></a>
<FONT color="green">489</FONT>      public synchronized UserRef makeUserRef(User user) {<a name="line.489"></a>
<FONT color="green">490</FONT>        UserRef ref = new UserRef();<a name="line.490"></a>
<FONT color="green">491</FONT>        ref.setEmail(user.getEmail());<a name="line.491"></a>
<FONT color="green">492</FONT>        ref.setHref(this.server.getHostName() + "users/" + user.getEmail()); <a name="line.492"></a>
<FONT color="green">493</FONT>        return ref;<a name="line.493"></a>
<FONT color="green">494</FONT>      }<a name="line.494"></a>
<FONT color="green">495</FONT>      <a name="line.495"></a>
<FONT color="green">496</FONT>    }<a name="line.496"></a>
<FONT color="green">497</FONT>    <a name="line.497"></a>




























































</PRE>
</BODY>
</HTML>
